home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / string / RCS / stringArray.man,v < prev    next >
Text File  |  1991-04-23  |  2KB  |  73 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     91.04.23.18.00.46;  author kupfer;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @Man page for String_SaveArray and String_FreeArray.
  17. @
  18.  
  19.  
  20.  
  21. 1.1
  22. log
  23. @Initial revision
  24. @
  25. text
  26. @'\" Copyright 1991 Regents of the University of California
  27. '\" Permission to use, copy, modify, and distribute this
  28. '\" documentation for any purpose and without fee is hereby
  29. '\" granted, provided that this notice appears in all copies.
  30. '\" The University of California makes no representations about
  31. '\" the suitability of this material for any purpose.  It is
  32. '\" provided "as is" without express or implied warranty.
  33. '\" 
  34. '\" $Header: /sprite/lib/forms/RCS/lib.man,v 1.3 91/01/07 17:55:52 mottsmth Exp $ SPRITE (Berkeley)
  35. '/" 
  36. .so \*(]ltmac.sprite
  37. .HS String lib
  38. .BS
  39. '\" Note:  do not modify the .SH NAME line immediately below!
  40. .SH NAME
  41. String_SaveArray, String_FreeArray \- copy and destroy null-terminated string array
  42. .SH SYNOPSIS
  43. .nf
  44. \fB#include <spriteString.h>\fR
  45. .sp
  46. char **
  47. \fBString_SaveArray\fR(\fIstringsPtr\fP)
  48. .sp
  49. char **
  50. \fBString_FreeArray\fR(\fIstringsPtr\fR)
  51. .SH ARGUMENTS
  52. .AS char **stringsPtr
  53. .AP char **stringsPtr in
  54. Pointer to a null-terminated array of string pointers.
  55. .BE
  56.  
  57. .SH DESCRIPTION
  58. .PP
  59. These routines create and destroy null-terminated arrays of strings.
  60. They are useful for making copies of the
  61. .B argv
  62. argument array or of a host alias list.
  63. .B String_SaveArray
  64. creates new copies of the strings and of the array of pointers.
  65. .B String_FreeArray
  66. frees the strings and the array.  It returns a nil pointer that can be
  67. used to nil out the given
  68. .IR stringsPtr .
  69.  
  70. .SH KEYWORDS
  71. string, copy
  72. @
  73.